/**
 * Copyright (c) 2013-2022 Nikita Koksharov
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.redisson.client.handler;

/**
 * State类用于表示某种状态，包含批次索引、级别和一个通用值。
 * 批次索引用于标识状态所属的批次，级别用于表示状态的优先级或层次，值可以是任意类型，用于承载与状态相关的具体信息。
 */
public class State {

    private int batchIndex; // 批次索引，用于标识状态所属的批次

    private int level = -1; // 状态的级别，初始值为-1，表示未设定级别

    private Object value; // 状态的值，可以是任意类型，用于承载与状态相关的具体信息

    /**
     * 默认构造函数，用于创建一个空的State对象。
     */
    public State() {
    }

    /**
     * 获取状态的值。
     *
     * @return 状态的值，类型为泛型T，允许调用者根据需要将其强制转换为适当的类型。
     */
    public <T> T getValue() {
        return (T) value;
    }

    /**
     * 设置状态的值。
     *
     * @param value 新的状态值，可以是任意类型。
     */
    public void setValue(Object value) {
        this.value = value;
    }

    /**
     * 获取状态的级别。
     *
     * @return 状态的级别，以整数形式表示。
     */
    public int getLevel() {
        return level;
    }

    /**
     * 级别增加。
     *
     * 此方法用于将状态的级别增加1，通常用于表示状态的重要性提升或层次加深。
     */
    public void incLevel() {
        level++;
    }

    /**
     * 级别减少。
     *
     * 此方法用于将状态的级别减少1，通常用于表示状态的重要性降低或层次变浅。
     */
    public void decLevel() {
        level--;
    }

    /**
     * 设置批次索引。
     *
     * @param index 新的批次索引，用于标识状态所属的批次。
     */
    public void setBatchIndex(int index) {
        this.batchIndex = index;
    }

    /**
     * 获取批次索引。
     *
     * @return 批次索引，用于标识状态所属的批次。
     */
    public int getBatchIndex() {
        return batchIndex;
    }

    /**
     * 以字符串形式表示当前状态。
     *
     * @return 字符串形式的状态表示，包含批次索引和级别。
     */
    @Override
    public String toString() {
        return "State [batchIndex=" + batchIndex + ", level=" + level + "]";
    }

}
